/*
 * 版权所有 (C) 2015 知启蒙(ZHIQIM) 保留所有权利。[遇见知启蒙，邂逅框架梦，本文采用木兰宽松许可证第2版]
 * 
 * https://zhiqim.org/project/zhiqim_kit/zhiqim_git.htm
 *
 * ZhiqimGit is licensed under Mulan PSL v2.
 * You can use this software according to the terms and conditions of the Mulan PSL v2.
 * You may obtain a copy of Mulan PSL v2 at:
 *          http://license.coscl.org.cn/MulanPSL2
 * THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
 * EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
 * MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
 * See the Mulan PSL v2 for more details.
 */
package org.zhiqim.git;

import java.util.concurrent.Callable;

/**
 * Git命令基类
 * 
 * 1、提供外部统一的调用方法
 * 2、子类可选和必须实现的预处理和执行方法
 * 3、子类构造函数统一传入仓库对象
 * 
 * @version v1.0.0 @author zhichenggang 2017-3-25 新建与整理
 */
public abstract class GitCommand<T> implements Callable<T>, GitConstants
{
    protected final Git git;
    
    protected GitCommand(Git git)
    {
        this.git = git;
    }

    /*********************************************************************/
    //调用
    /*********************************************************************/

    /**
     * 提供给外部统一的调用方法
     */
    public final T call() throws Exception
    {
        preprocess();
        
        return execute();
    }
    
    /*********************************************************************/
    //子类可选和必须实现的预处理和执行方法
    /*********************************************************************/
    
    /**
     * 子类可选重写的预处理方法
     */
    protected void preprocess()
    {
    }
    
    /**
     * 子类必须实现的执行方法
     * 
     * @return 返回指定的调用后的对象
     * @throws Exception
     */
    protected abstract T execute() throws Exception;
}
